NewTrack v3.01 -------------- File: README.TXT 23-Dec-1994 This file contains up-to-the-minute information on NewTrack v3.01. ============================================================ Contents ============================================================ 1. What is NewTrack? 2. Installation of Full NewTrack v3.01 3. Installation of Shareware NewTrack v3.01 4. Quick Start with NewTrack 5. Borland C/C++ Notes 5.1 Using the DLL version of the Borland Run-Time Library 5.2 Borland BIDS (ClassLib) DLL 5.3 Borland Object Windows Library v2+ (OWL) 6. Microsoft Visual C++ 7. Rebuilding the libraries 8. Technical Support, Bug Reports & Enhancement Requests 9. Site License Inquiries 10. Where to find supporting documentation 11. Software License Agreements 12. Restrictions on Capabilities of Shareware NewTrack 13. Ordering Full NewTrack 14. Monetary Incentives to Spread the Word about NewTrack 15. Extracting Shareware NewTrack for distribution ============================================================ 1. What is NewTrack? -------------------- NewTrack is a software library, which assists developers of Microsoft Windows software in C or C++ by automatically tracking and validating their use of dynamically allocated memory. It makes it very easy to identify errors which otherwise can take days or weeks to track down. It supports development using Microsoft C++, Borland C++ v3.1 and Borland C++ v4.02 for WIN16 and WIN32 programming. NewTrack is so effective, that we have identified bugs in Microsoft's MFC v2.5 class library which have apparently not otherwise been found. NewTrack introduces no overhead into your production programs, since it is only included in programs during development. NewTrack is offered in a Shareware version for evaluation purposes, and a single-user Full version for US$99. It can also be licensed for site or corporate use for a minimum of US$1,000. We offer monetary incentives to purchasers of the single-user Full version to encourage you to spread the word about NewTrack to other potential users. 2. Installation of Full NewTrack v3.01 -------------------------------------- ************************************************************ Please remove all previous copies of NewTrack before installation, remembering to remove old copies of the NewTrack DLL copied onto your path. ************************************************************ To install NewTrack v3.01, insert the distribution disk into drive A: or B:, and start Windows. In Program Manager, select File|Run from the menu and type: A:\INSTALL or B:\INSTALL as appropriate. The installation program will prompt you as necessary for the installation directory. 3. Installation of Shareware NewTrack v3.01 ------------------------------------------- To install the shareware version of NewTrack, simply create a directory (eg C:\NEWTRACK) and unzip the .ZIP file you downloaded using PKUNZIP v2.04g (or higher) and the -d option. For example: C:\> md newtrack C:\> cd newtrack C:\NEWTRACK> pkunzip -d c:\download\newt30ms.zip A program called NTGROUPS.EXE has been provided with the shareware version of NewTrack to setup a Program Manager group and icons for NewTrack. This is a Windows application, and must be run from Program Manager's File|Run menu option. It expects a single command-line parameter, which is the directory you installed Shareware NewTrack into. Eg, assuming that you installed NewTrack into the C:\NEWTRACK directory, as above, then from the File|Run menu option, type: C:\NEWTRACK\NTGROUPS C:\NEWTRACK You can then delete the .ZIP file if you no longer need it. The full version of NewTrack includes a complete installation utility. 4. Quick Start with NewTrack ---------------------------- To find out how to quickly start using NewTrack, double-click on the Quick Start icon in the installed NewTrack v3.01 program group. The full NewTrack User Guide is supplied on-line in Windows Help format, and can be accessed by double-clicking the On-Line Help icon in the installed NewTrack v3.01 program group. 5. Borland C/C++ Notes ====================== 5.1. Using the DLL version of the Borland Run-Time Library ---------------------------------------------------------- The Borland C/C++ versions of NewTrack include a module called RTLEXTRA.CPP. This needs to be used when using the DLL version of the Run-Time Library to prevent valid uses of the RTL functions from generating errors. This module has been compiled into the NEWT_D??.LIB NewTrack libraries (the DLL versions of NewTrack) - IE, if you use the DLL version of NewTrack, it is assumed that you are also using the DLL version of the RTL. However: The NewTrack DLL has to load the Borland C/C++ RTL DLL in order to operate, and will assume that the name of the RTL DLL is the default (eg "BC30RTL.DLL" or "BC402RTL.DLL"). Therefore, if you have changed the name of the RTL DLL, you will still need to keep the old RTL DLL around while debugging with NewTrack. 5.2. Borland Class Library (BIDS) --------------------------------- If you are using the DLL version of BIDS, you will need to rebuild the BIDS DLL before using it with NewTrack. Instructions for doing this can be found in the Quick Start Guide. 5.3. Borland Object Windows Library v2+ (OWL) --------------------------------------------- For step-by-step instructions for adding NewTrack into your application with OWL, see the Quick Start Guide. Please note that only OWL version 2 is supported by NewTrack, and only when OWL v2 is used with Borland C/C++ v4.02 or higher. If you are using the DLL version of OWL, you will need to rebuild the BIDS DLL and the OWL DLL before using it with NewTrack. Instructions for doing this are in the Quick Start Guide. 6. Microsoft Visual C++ ======================= For step-by-step instructions for adding NewTrack into your application with MFC, see the Quick Start Guide. When linking with Microsoft Visual C/C++, it is necessary to use the /NOE switch (or Options|Project|Linker|Input| Prevent Use Of Extended Dictionary in the VC++ IDE) because NewTrack redefines a number of library functions. If you include the NEWTRACK.CPP file into your project directly AND you use precompiled headers, then you must either compile NEWTRACK.CPP with precompiled headers turned off or modify NEWTRACK.CPP to uncomment the line: //#include "stdafx.h" otherwise the compiler will display the following error message: "...reached end-of-file looking for precompiled header directive" Note that we recommend using the supplied NEWT_X??.LIB libraries instead of placing NEWTRACK.CPP into your project directly. You can use either the static MFC library or the DLL version. Please note that Visual C++ v1.0 for Windows 3.1 is NOT supported; however, v1.5 for Windows 3.1 and v1.1 for Windows NT 3.1 are supported. 7. Rebuilding the libraries --------------------------- If you need to rebuild the NewTrack Libraries, the Make files (DISTRIB.MAK and MK*.INC) support both Borland's MAKE and Microsoft's NMAKE. When rebuilding, the DISTRIB.BAT file will use NMAKE to compile Visual C++ libraries, and MAKE to compile Borland C++ libraries. 8. Technical Support, Bug Reports & Enhancement Requests -------------------------------------------------------- Our main concern in providing Technical Support is to get you up and running with NewTrack. We hope you will find this is a straightforward process, but if you have problems please don't struggle on needlessly when a fax or E-Mail could solve the problem. In addition to contacting us to request technical support and report bugs, we would also appreciate your feedback & suggestions for enhancements & future products. You can contact us via: John Spackman Cavendish Software Limited 50 Avenue Road Trowbridge Wilts BA14 0AQ England Fax: International 44-1225-777359 United Kingdom 01225-777359 CompuServe: 100034,207 International fax users should prefix the fax number with the code to obtain access to the international phone network. For example, from the USA, the complete fax number is 011-44-1225-777359. When contacting us for technical support or to report bugs, please notify us of the following minimum information: * Which C++ compiler version you are using. * Whether you are doing WIN16 or WIN32 development. * Whether you are using the Full or Shareware product. * Full description of the problem, and how to reproduce it. * If you have the Full product, your Customer Account Number. Your Customer Account Number can be located either on the invoice for the product, on the NewTrack disk label or in the Windows Help File contents. 9. Site License Inquiries ------------------------- Inquiries concerning Site or Corporate Licenses should be sent to us at the address given in section 5 of this file. 10. Where to find supporting documentation ------------------------------------------ All computer-based documentation for NewTrack (other than this file itself) can be found in the DOC sub-directory under the NewTrack installation directory. Icons are provided in the NewTrack v3.01 program group by the installation program to access this documentation. PLEASE NOTE THAT ALL DOCUMENTATION IS LAID OUT TO FIT ON Letter 8 1/2 X 11 in PAPER. IF THIS IS NOT THE DEFAULT PAGE SIZE FOR YOUR PRINTER, YOU SHOULD CHANGE TO THIS USING NOTEPAD'S OR WRITE'S PRINTER SETUP MENUS. 11. Software License Agreements ------------------------------- NewTrack v3 is distributed in a Shareware version and a single-user Full Version. Your legal rights to use and distribute the two versions are fully specified in their Software License Agreements. You should read and understand these before using or distributing NewTrack v3. The Shareware NewTrack v3 Software License Agreement can be found in the file SHLICENS.WRI in Windows Write v3.1 format. The Full NewTrack v3 Software License Agreement can be found in the file LICENSE.WRI in Windows Write v3.1 format. Site Licensing of NewTrack is also available for a minimum price of US$1,000. Contact Cavendish Software as specified in section 5 above for further details. 12. Restrictions on Capabilities of Shareware NewTrack ------------------------------------------------------ The shareware version of NewTrack is restricted in that the stack trace is limited to 2 function calls deep. The full version gives a stack trace to a depth of 10 function calls, which experience has shown to be a suitably high number. The shareware version only allows you to see the class stack as an array of pointers to the calling code, and only while under the debugger. The full version, however, will decode the debug symbols of the executable or DLL and provide a human readable dump of unfreed memory, down to the source file line and name, and the .EXE or .DLL module that the memory was allocated from. The full version also comes with printed documentation, whereas the shareware version has only Windows Help format documentation. If you order the full version, you also get your own personal shareware version of NewTrack. We offer you the opportunity to make money by distributing this to other users. See the order form described in section 13 below for details. 13. Ordering Full NewTrack -------------------------- To order Site Licenses, please contact Cavendish Software as specified in section 5 above. To order single-user Full NewTrack, please use the order form supplied in file ORDER.WRI in Windows Write v3.1 format, or file ORDER.TXT in plain text format. The NewTrack program group contains icons to access these order forms. 14. Monetary Incentives to Spread the Word about NewTrack --------------------------------------------------------- You can make money by helping to spread the word about NewTrack! See the order form described in section 13 above for details. 15. Extracting Shareware NewTrack for distribution -------------------------------------------------- If you have obtained single-user Full NewTrack, you will want to distribute your personal copy of Shareware NewTrack in order to take advantage of our monetary incentive scheme. Your personal Shareware NewTrack is supplied as three PKZIP files, two for Borland C++ and one for Microsoft Visual C++. These can be located on disk 2, and are named as follows: NEWT30MS.ZIP - Microsoft Visual C/C++ NEWT30B3.ZIP - Borland C/C++ v3.1 NEWT30B4.ZIP - Borland C/C++ v4.02 *** End of document ***